Refactoring Code Snippets (#1631) #1632
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR implements a major repository reorganization to align with the updated contribution guidelines and improve the overall structure of the ServiceNow Developer Program's Code Snippets Repository. Key Changes 🗂️ Repository Structure Overhaul: Reorganized all 900+ code snippets into the standardized 6 top-level categories as defined in the updated contribution guidelines 📋 Enhanced Documentation: Added comprehensive AGENTS.md file with detailed repository guidelines, development standards, and contribution requirements 🔧 Configuration Updates: Updated Agent settings and GitHub workflow configurations 📁 Category Standardization: Moved all existing snippets from previous directory structure to the new mandatory category structure: Core ServiceNow APIs/ (GlideRecord, GlideAjax, GlideDateTime, etc.) Server-Side Components/ (Business Rules, Script Includes, Background Scripts, etc.) Client-Side Components/ (Client Scripts, UI Actions, Catalog Client Scripts, etc.) Modern Development/ (Service Portal, NOW Experience, GraphQL, etc.) Integration/ (REST APIs, Import Sets, Mail Scripts, etc.) Specialized Areas/ (CMDB, ITOM, Performance Analytics, etc.) Technical Improvements 📝 Documentation Standardization: All code snippets now follow consistent README.md documentation patterns 🔍 Improved Discoverability: Better categorization makes finding relevant code examples more intuitive ⚡ Enhanced Maintainability: Clearer structure reduces contribution friction and improves code review process 🛡️ Quality Enforcement: Updated guidelines ensure higher code quality and consistency across all contributions Breaking Changes Directory Structure: All file paths have changed due to reorganization Navigation: Links and bookmarks to specific snippets will need to be updated Contribution Process: New submissions must follow the mandatory 6-category structure This refactoring establishes a solid foundation for the repository's continued growth while maintaining the high-quality, practical ServiceNow development examples that make this resource valuable to the community.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements a major repository reorganization to align with the updated contribution guidelines and improve the overall structure of the ServiceNow Developer Program's Code Snippets Repository.
Key Changes
🗂️ Repository Structure Overhaul: Reorganized all 900+ code snippets into the standardized 6 top-level categories as defined in the updated contribution guidelines
📋 Enhanced Documentation: Added comprehensive AGENTS.md file with detailed repository guidelines, development standards, and contribution requirements
🔧 Configuration Updates: Updated Agent settings and GitHub workflow configurations
📁 Category Standardization: Moved all existing snippets from previous directory structure to the new mandatory category structure: Core ServiceNow APIs/ (GlideRecord, GlideAjax, GlideDateTime, etc.) Server-Side Components/ (Business Rules, Script Includes, Background Scripts, etc.)
Client-Side Components/ (Client Scripts, UI Actions, Catalog Client Scripts, etc.)
Modern Development/ (Service Portal, NOW Experience, GraphQL, etc.) Integration/ (REST APIs, Import Sets, Mail Scripts, etc.) Specialized Areas/ (CMDB, ITOM, Performance Analytics, etc.) Technical Improvements
📝 Documentation Standardization: All code snippets now follow consistent README.md documentation patterns
🔍 Improved Discoverability: Better categorization makes finding relevant code examples more intuitive
⚡ Enhanced Maintainability: Clearer structure reduces contribution friction and improves code review process
🛡️ Quality Enforcement: Updated guidelines ensure higher code quality and consistency across all contributions
Breaking Changes
Directory Structure: All file paths have changed due to reorganization Navigation: Links and bookmarks to specific snippets will need to be updated
Contribution Process: New submissions must follow the mandatory 6-category structure
This refactoring establishes a solid foundation for the repository's continued growth while maintaining the high-quality, practical ServiceNow development examples that make this resource valuable to the community.